home *** CD-ROM | disk | FTP | other *** search
/ Fritz: All Fritz / All Fritz.zip / All Fritz / FILES / GAMETORS / RAILSWTC.LZH / RRSWITCH.DOC < prev    next >
Text File  |  1989-09-01  |  13KB  |  260 lines
  1.                   RRSWITCH:  RAILROAD SWITCH CHALLENGE
  2.                   Version 5.0,(c) 1982-89, Fred Miller
  3.  
  4.           ------------
  5.           INTRODUCTION
  6.           ------------
  7.  
  8.           RAILROAD SWITCH CHALLENGE is a PC program designed to chal-
  9.           lenge the best of the armchair wayfreight train crews.  The
  10.           game objective of RRSWITCH is to move railroad freight cars
  11.           along simulated tracks to industry locations, and subse-
  12.           quently assemble a departing freight train on the mainline
  13.           track.  The program and it's "layout" is loosely patterned
  14.           after John Allen's TIMESAVER.
  15.  
  16.           RRSWITCH was originally written in 1982 to run on TRS-80 
  17.           Model I PCs.  Since that time the program has been modified
  18.           to take advantage of better graphics and color.  This version
  19.           has been prepared to run on MS-DOS based PCs with CGA or bet-
  20.           ter color graphics.  Although it will operate on the original
  21.           IBM PC (or TANDY 1000), the higher speeds of later PCs pro-
  22.           vide for better graphics movement.  The program will operate
  23.           on DOS 2 or better on a machine with at least 256K.
  24.  
  25.           The program requires three files: RRSWITCH.EXE, RRSWITCH.OVL,
  26.           and RRSWITCH.DAT to operate, and optionally RRSWITCH.TAB for 
  27.           saving scores.  This file, RRSWITCH.DOC, is not necessary for
  28.           program operation but it should be included whenever the
  29.           other files are copied.
  30.  
  31.           ----------------------
  32.           OPERATING INSTRUCTIONS
  33.           ----------------------
  34.  
  35.           Note: An abbreviated version of these instructions is always
  36.           available "on-screen" with a key press from the pop-up menu.
  37.  
  38.           Randomly generated switching assignments must be accomplished
  39.           in a minimum of moves and with a minimum of demerits within a
  40.           prescribed time limit.  Moves are counted for each change in
  41.           direction of the engine. Demerits are accumulated by running
  42.           off the end of a track, by hitting (or trying to push) a car
  43.           not coupled to the current train/engine, or by running a track
  44.           switch not appropriately set to the train route.
  45.  
  46.           New (or repeated) switching assignments are generated and
  47.           displayed in the upper left of the track layout screen.  A
  48.           running total of moves and demerits is displayed in the upper
  49.           right portion of the screen, along with the time expended. 
  50.           Guidance messages are displayed on the bottom.
  51.                                                          +---+---+---+
  52.           The numeric keypad (keys as shown ->) is used  | 7 | 8 | 9 |
  53.           to control all train action.  One hand, touch  +---+---+---+
  54.           control becomes second nature after a few      | 4 | 5 | 6 |
  55.           trial runs. (Note that the NUMERIC LOCK and    +---+---+---+
  56.           CAPS LOCK modes are automatically set and re-  | 1 | 2 | 3 |
  57.           leased by the program.)                        +---+---+---+
  58.  
  59.           Routes are set by first selecting a switch with KEY-7, then
  60.           setting the upper route with KEY-8, or the lower route with
  61.           KEY-2.
  62.  
  63.           Couplers are set by first selecting a coupling position with
  64.           KEY-9, then uncoupling with KEY-1, or coupling with KEY-3.
  65.  
  66.           The engine is moved Westbound by KEY-4, and Eastbound by
  67.           KEY-6.
  68.  
  69.           ---------------
  70.           THE POP-UP MENU
  71.           ---------------
  72.  
  73.           KEY-5 is used to access a pop-up menu displayed in the cen-
  74.           ter of the screen.  Current game action may be continued
  75.           after executing the various menu options.
  76.  
  77.           The pop-up menu functions and mode options are selected by
  78.           pressing the designated key, or by moving the hi-lite bar
  79.           to the selection, and then pressing [ENTER].  The selections
  80.           available are:
  81.  
  82.           [N] = start a NEW switching assignment,
  83.           [R] = RESTART the same assignment from the beginning,
  84.           [C] = CONTINUE the current assignment,
  85.           [P] = manually POSITION the cars on the layout to set up a
  86.                 specific assignment,
  87.           [L] = LIST previously saved scores, and optionally select a
  88.                 previously recorded assignment to rerun,
  89.           [D] = run automated DEMONSTRATION (continuously until stopped),
  90.           [H] = display the five HELP panels,
  91.           [E] = change ENGINEER's identification,
  92.           [G] = display the scoring GOALS set for current assignment,
  93.           [S] = toggle the SAVE Scores option ON or OFF,
  94.           [M] = toggle the MUSICAL note emphasis ON or OFF,
  95.           [T] = toggle the elapsed TIME game termination ON or OFF,
  96.           [Q] = QUIT the program and return to DOS.
  97.  
  98.           --------------------
  99.           STARTING THE PROGRAM
  100.           --------------------
  101.  
  102.           RAILROAD SWITCH CHALLENGE is started from DOS by typing
  103.           'RRSWITCH'.  Various command line options may also be set
  104.           at start-up.  The following run options can be included on
  105.           the command line by typing the parameters in any sequence:
  106.  
  107.           C  = use more attractive colors available through TANDY's CGA
  108.                and IBM PCjr,
  109.           V  = also better colors for EGA or VGA (but still 320 x 200),
  110.           NH = suppress display of help panels at initial program load,
  111.           NR = suppress randomized switch assignments (recycle through
  112.                the same assignments each time program is loaded),
  113.           NM = suppress musical emphasis at demerit or end
  114.                of game, (starts program with music toggled OFF),
  115.           D  = start program with an automated demonstration assignment,
  116.           P  = start program ready to manually position cars,
  117.           S  = start program with Save Scores option toggled ON,
  118.           NT = suppress the timer option (start program with the game
  119.                abort Timer OFF)
  120.  
  121.           Note that upper or lower case can be used and that no punctu-
  122.           ation, (commas, spaces) is necessary.  For example, a DOS
  123.           command of 'RRSWITCH C NH D' would start the program in auto-
  124.           matic demonstration mode using the TANDY colors, skipping the
  125.           HELP screens.  The command line entry of 'rrswitch cnhd' would
  126.           give the same results. 
  127.  
  128.           An additional command line option is provided to set the time-
  129.           per-car timeout.  The syntax is T=nnn where nnn is the number
  130.           seconds per car (including caboose.)  A default value of 60
  131.           seconds will be used if this option (T=) is not specified.  Note
  132.           that the 'NT' command line option and the 'T' Pop-up menu toggle
  133.           will determine whether game assignments will be terminated at 
  134.           the end of the elapsed time regardless of the time-per-car
  135.           setting.  The elapsed time will always be displayed in the 
  136.           upper right screen, clicking away in 5 second increments, re-
  137.           gardless of the NT or T toggle settings.
  138.  
  139.           At initial start, the program will ask for the engineer's
  140.           initials.  (DEM will be used for DEMO mode.) Three non-blank
  141.           keystrokes are required.  The engineer's identification will
  142.           be displayed on the screen and also posted in RRSWITCH.TAB
  143.           with the game description and scores, if the save option is
  144.           toggled ON.  The engineer's ID can be changed at anytime from
  145.           the appropriate menu selection.
  146.  
  147.           ---------------------
  148.           ASSIGNMENT GENERATION
  149.           ---------------------
  150.  
  151.           A number of alternative approaches to generation of each new
  152.           switching assignment are possible.  The default at startup
  153.           (or selection from the pop-up menu) is NEW, a completely random
  154.           generation of car placements.  In addition, a previous assign-
  155.           ment may be selected for replay from the RRSWITCH.TAB file
  156.           through use of the LIST/SELECT option on the menu.  And still 
  157.           another alternative is that of manual specific car placement
  158.           by use of the <P> POSITION option on the menu.  The DEMO mode
  159.           also generates a fixed assignment for automatic operation.
  160.           
  161.           Whichever assignment generation approach is used, the car 
  162.           placement can be immediately regenerated either during or
  163.           immediately after completion by using the <R> RESTART option
  164.           on the menu.
  165.  
  166.           -----------------
  167.           RRSWITCH.TAB FILE
  168.           -----------------
  169.  
  170.           When the Save Score option is toggled on, the final results
  171.           of each switching assignment will be written to a file named
  172.           RRSWITCH.TAB.  The contents of this file can also be displayed
  173.           at any time from the pop-up menu.  The file can also be edited
  174.           with any ASCII text editor to delete entries, etc.  If the
  175.           file does not exist, a new one will be created if scores are
  176.           saved.  The format of each record (line) of the RRSWITCH.TAB
  177.           file is:
  178.  
  179.                    Positions  1-3  = Engineer's Identification
  180.                    Position    4   = "|"
  181.                    Positions  5-12 = Date stamp
  182.                    Position    13  = "|"
  183.                    Position  14-16 = Total score
  184.                    Position    17  = "="
  185.                    Position  18-22 = Score evaluation
  186.                    Position    23  = "|"
  187.                    Position  24-32 = Starting car locations, e.g.,
  188.                                      240000005 means car 1 at location
  189.                                      2, car 2 at 4, and car 9 at 5. A '0'
  190.                                      location means the car is not placed.
  191.                    Position    33  = "|"
  192.  
  193.           Note that the Starting car locations are described in the 
  194.           same format as would be called for in using the manual car
  195.           positioning mode ("P" on the pop-up menu)
  196.  
  197.           -----------------
  198.           VERSION 4 CHANGES
  199.           -----------------
  200.  
  201.           The following summarizes the significant changes in
  202.           RRSWITCH, Version 4:
  203.  
  204.           - Pop-up Menu providing easy selection of options,
  205.           - Manual positioning of cars as optional mode of play,
  206.           - Saving and later display of game and scores,
  207.           - Some enhanced graphics presentations,
  208.           - Enhanced algorithm for evaluating scores,
  209.           - Several obscure bugs and typos removed (hopefully without
  210.             adding additional ones.)
  211.  
  212.           -----------------
  213.           VERSION 5 CHANGES
  214.           -----------------
  215.  
  216.           - The time elapsed for each assignment is shown on the screen,
  217.           - The TIMER option was added to terminate the assignment if
  218.             more than 1 minute per car was used, optionally any value of
  219.             seconds per car.  This timing option can be active or disabled.
  220.           - The assignment scoring goals (TIME/MOVES) displayed at any
  221.             time through the pop-up menu selection. 
  222.           - DEMO mode can be terminated at any time.  If not terminated,
  223.             the demonstration will continue to recycle the same assign-
  224.             ment over and over.  (GREAT FOR SHOWS!)
  225.           - Additional minor bug fixes and added conveniences. 
  226.  
  227.           -------------------
  228.           NECESSARY LEGALEEZE
  229.           -------------------
  230.  
  231.           This program is donated to the PUBLIC DOMAIN, for NON-
  232.           COMMERCIAL use.  The program including this file may be
  233.           freely copied for such use without any restrictions.  However
  234.           COMMERCIAL use or distribution without prior written consent
  235.           of the author is PROHIBITED.  The program is provided "as is"
  236.           without warranty of any kind, either expressed or implied,
  237.           including, but not limited to the implied warranties of mer-
  238.           chantability or fitness for a particular purpose.  The entire
  239.           risk as to results and performance of the program is assumed
  240.           by the user. Should the program prove defective, the user as-
  241.           sumes the entire responsibility for necessary servicing,
  242.           repair or correction.
  243.  
  244.           -----------
  245.           CONCLUSIONS
  246.           -----------
  247.  
  248.           If you enjoy using this program, the author would like to
  249.           hear from you.  A small donation of $10 will get you on a mail-
  250.           ing list and pay for subsequent improved versions.  Regardless,
  251.           comments and suggestions would always be welcome and may be
  252.           forwarded to the author at CompuServe address 72207,3273, or:
  253.  
  254.                                FRED MILLER 
  255.                                7 TEMPLAR WAY
  256.                                PARSIPPANY, NJ 07054
  257.  
  258.           Enjoy!
  259.  
  260.